Skip to content

Updating an existing Task Status Set

Request

Updates a task status set. Only the name can be updated with this endpoint. To update the statuses available in the set, use the Custom Task Statuses API instead. To change which set is the account default, use the Set Account Default Task Status Set endpoint instead.

This endpoint returns structured Task Status Set objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the task_status_sets top-level JSON key. Please see our Response Format section for more information.

Path
idintegerrequired

The ID of the Model.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • custom_task_statuses (StatusSetOption) - Retrieves all of the statuses within this status set. The response will include custom_task_status_ids, which references the data in the custom_task_statuses top-level key.
Bodyapplication/jsonrequired
task_status_setobject
{
  "task_status_set": {
    "name": "string"
  }
}

Responses

Task Status Set has been updated.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
task_status_setsobject
custom_task_statusesobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "task_status_sets": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "custom_task_status_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "custom_task_status_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "custom_task_statuses": {
    "property1": {
      "category": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "position": 0,
      "status": "string",
      "status_set_id": 0,
      "task_status_set_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "category": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "position": 0,
      "status": "string",
      "status_set_id": 0,
      "task_status_set_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}